dxp-ux
List billingAccount (TMF-666)
/billingAccount
[GET]
This operation retrieves a billing account entity used by identityType & identityNumber or locationId.
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccountURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PR, JM, PA, etc.) identifying the business unit. | Y |
Header
NOTE: To retrieve debit check details based on SSN need to pass "x-tax-identifier"
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| x-tax-identifier | string | Tax identifier value/ SSN. This is encrypted value. | N |
| channeId | string | Channel to identify the business group. Can be: "APP" | M |
| Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Pattern: ^[a-zA-Z0-9-+/=_]{16,64}$ Minimum characters: 16 Maximum characters: 64 | N |
| lob | String | Enum: PREPAID, POSTPAID,FIXED Expected value : FIXED | O |
Query Param
NOTE: To retrieve debit check details based on Location ID need to pass "locationId "
| name | type | description | required |
|---|---|---|---|
| identityType | string | Describes the type of the id. Eg: "SSN" | N |
| balanceCheck | boolean | Flag for customer account debt information. API will return customer accounts balance if this flag is true. | N |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
[ 200 ]
From this operation we can fetch Auto Pay is enabled or disabled, auto pay date and day, Delinquency status, payment status.
Note In the response if PaymentPlan.planType is AutoPay Enable, AutoPay Date can be dislpayed in the extended Characteristics else AutoPay Date cannot be displayed.
By SSN (x-tax-idenitfier)
AutoPay Enable for debtCheck by SSN
[
{
"id": "8211990010009223",
"name": "TIVO APP TEST LIBERTY GO",
"@type": "BillingAccount",
"accountType": "RES",
"state": "E",
"paymentStatus": "E",
"paymentPlan": [
{
"planType": "Auto Pay Enable"
}
],
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": -135.33
},
"balanceType": "AccountBalance",
"validFor": {
"startDateTime": "2022-12-13",
"endDateTime": "2023-01-12"
}
},
{
"amount": {
"unit": "USD",
"value": 0.00
},
"balanceType": "DelinquentBalance"
}
],
"creditLimit": {
"unit": "USD",
"value": 100.00
},
"contact": [
{
"contactName": "TIVO APP TEST LIBERTY GO",
"contactMedium": [
{
"mediumType": "Address",
"preferred": true,
"characteristic": {
"contactType": "BillingAddress",
"stateOrProvince": "PR",
"city": "SAN JUAN",
"street1": "279 AVE PONCE DE LEON",
"street2": "APT 8",
"postCode": "009171920"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Home",
"phoneNumber": "7879257001"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Business",
"phoneNumber": "9059334010"
}
}
]
}
],
"relatedParty": [
{
"id": "1101520693636",
"name": "TIVO APP TEST LIBERTY GO",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"name": "autoPayDate",
"value": "2023-01-07T00:00:00.000Z"
},
{
"name": "DebitDay",
"value": "03"
},
{
"name": "CreditScore",
"value": "A"
},
{
"name": "LocationId",
"value": "00917192001084"
}
]
}
]AutoPay Disable for debtCheck by SSN
[
{
"id": "8211990010013175",
"name": "FABIAN DIAZ",
"@type": "BillingAccount",
"accountType": "RES",
"state": "E",
"paymentStatus": "E",
"paymentPlan": [
{
"planType": "Auto Pay Disable"
}
],
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 194.78
},
"balanceType": "AccountBalance",
"validFor": {
"startDateTime": "2022-12-26",
"endDateTime": "2023-01-25"
}
},
{
"amount": {
"unit": "USD",
"value": 194.78
},
"balanceType": "DelinquentBalance"
}
],
"creditLimit": {
"unit": "USD",
"value": 100.00
},
"contact": [
{
"contactName": "FABIAN DIAZ",
"contactMedium": [
{
"mediumType": "Address",
"preferred": true,
"characteristic": {
"contactType": "BillingAddress",
"stateOrProvince": "PR",
"city": "SAN JUAN",
"street1": "279 AVE PONCE DE LEON",
"street2": "APT 2004",
"postCode": "009171920"
}
},
{
"mediumType": "Phone",
"characteristic": {
"contactType": "Home",
"phoneNumber": "3184337043"
}
}
]
}
],
"relatedParty": [
{
"id": "1101521367339",
"name": "FABIAN DIAZ",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"name": "CreditScore",
"value": "A"
},
{
"name": "LocationId",
"value": "00917192001084"
}
]
}
]By locationId
[
{
"id": "8211990010026953",
"@type": "BillingAccount",
"accountType": "RES",
"state": "NORMAL",
"paymentStatus": "NORMAL",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 70.22
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 50.22
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101523725161",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "917000000385",
"name": "locationId"
}
]
},
{
"id": "8211990010024400",
"@type": "BillingAccount",
"accountType": "RES",
"state": "E",
"paymentStatus": "E",
"accountBalance": [
{
"amount": {
"unit": "USD",
"value": 30.22
},
"balanceType": "AccountBalance"
},
{
"amount": {
"unit": "USD",
"value": 20.22
},
"balanceType": "DelinquentBalance"
}
],
"relatedParty": [
{
"id": "1101522746259",
"role": "Customer",
"@referredType": "Individual"
}
],
"characteristic": [
{
"valueType": "string",
"value": "917000000385",
"name": "locationId"
}
]
}
]Expected values for CSG FIXED Auto Pay
| Field Name | Description |
|---|---|
| paymentStatus | blank - Active or Normal S - Suspended B - Balance is less than EFT minimum debit amount D - Debit Error E - Prenote Error G - EFT debit had been sent to ACH processor P - Prenote Error W - Waiting |